Domain Class Reference

Domain binds Kanzi subsystems and objects together. More...

Classes
interface	PluginHandler
	Plugin handler implements the functionality for loading a plugin from the associated plugin file. More...

Public Member Functions
ColorWorkflow	getColorWorkflow ()
	Gets the currently configured color workflow.
MainLoopScheduler	getMainLoopScheduler ()
	Returns the main loop scheduler that controls tasks and timers.
MetaclassRegistry	getMetaclassRegistry ()
	Returns the metaclass registry that contains all available metadata in the domain.
long	getNative ()
	Gets a pointer to the backing C++ instance.
Object	getPlatformContext ()
	Returns the platform-specific context set by the active platform backend.
ResourceManager	getResourceManager ()
	Returns the resource manager that contains all registered resources in the domain.
TaskDispatcher	getTaskDispatcher ()
	Returns the task dispatcher of this domain.
KanziVersion	getVersion ()
	Gets Kanzi version.
void	loadKzb (String fileName) throws FileNotFoundException
	Loads a kzb file from the file system, if the file is not already loaded.
void	registerPlugin (Plugin plugin)
	Registers a plugin and the metadata it contains.
void	registerPluginHandler (String protocol, PluginHandler handler)
	Registers a plugin handler for a given protocol.
void	unregisterPluginHandler (String protocol)
	Unregisters existing plugin handler for a given protocol.

Detailed Description

Domain binds Kanzi subsystems and objects together.

All objects and subsystems in Kanzi are associated with a domain when created. Objects in the same domain share access to the same subsystems. Objects from different domains cannot be used together.

Member Function Documentation

getColorWorkflow()

ColorWorkflow getColorWorkflow

(

)

Gets the currently configured color workflow.

Returns

com.rightware.kanzi.ColorWorkflow in use.

getMainLoopScheduler()

MainLoopScheduler getMainLoopScheduler

(

)

Returns the main loop scheduler that controls tasks and timers.

Returns

Instance of the main loop scheduler.

getMetaclassRegistry()

MetaclassRegistry getMetaclassRegistry

(

)

Returns the metaclass registry that contains all available metadata in the domain.

Returns

Instance of the metaclass registry.

getNative()

long getNative

(

)

Gets a pointer to the backing C++ instance.

Returns

A pointer to the backing C++ instance. Type: kanzi::Domain*.

getPlatformContext()

Object getPlatformContext

(

)

Returns the platform-specific context set by the active platform backend.

On Android, this points to Android application context android.content.Context. On all other platforms, this is currently null.

Returns

Type-erased reference to platform-specific context.

getResourceManager()

ResourceManager getResourceManager

(

)

Returns the resource manager that contains all registered resources in the domain.

Returns

Instance of the resource manager.

getTaskDispatcher()

TaskDispatcher getTaskDispatcher

(

)

Returns the task dispatcher of this domain.

You can use the task dispatcher returned by this function to dispatch tasks that the system executes on the thread of this domain.

Returns

Instance of the task dispatcher.

getVersion()

KanziVersion getVersion

(

)

Gets Kanzi version.

Returns

com.rightware.kanzi.KanziVersion in use.

loadKzb()

void loadKzb

(

String

fileName

)

throws FileNotFoundException

Loads a kzb file from the file system, if the file is not already loaded.

You can also pass a cfg file that contains a list of kzb files that you want to load.

To load additional kzb files with the same name, use com.rightware.kanzi.ResourceManager#addKzbFile(String).

Parameters

fileName

The name of the kzb file or cfg file that contains a list of kzb files to load.

Exceptions

InvalidKzbFileException	Throws an InvalidKzbFileException when the kzb file is invalid.
FileNotFoundException	Throws a FileNotFoundException when the kzb file is not found.

registerPlugin()

void registerPlugin

(

Plugin

plugin

)

Registers a plugin and the metadata it contains.

Parameters

plugin

Plugin to be registered.

registerPluginHandler()

void registerPluginHandler	(	String	protocol,
		PluginHandler	handler )

Registers a plugin handler for a given protocol.

Parameters

protocol	The format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.
handler	A plugin handler that implements functionality for loading a plugin from the associated plugin file.

unregisterPluginHandler()

void unregisterPluginHandler

(

String

protocol

)

Unregisters existing plugin handler for a given protocol.

Parameters

protocol

The format of the plugin file identified by its extension serves as a protocol. For example "dll" for windows shared libraries.